Skip to main content

Send Notification to ODIN

πŸ“ Overview​

The SendNotificationToOdin API is used to send notifications or general messages to the Odin Diet and Dealer Terminal applications.

πŸ”— Endpoint​

MethodURL
POST<protocol>://<host name>:<service port>/<service name>/<tenantid>/v1/sendNotificationToOdin

Request​

The request consists of the following parameters:

πŸ“₯Request Parameters​

ParameterData TypeMandatory / OptionalDescription
labelstringMandatoryMSMQ Message Object label. Must contain the value "GENERAL".
messagestringMandatoryMessage structure as defined in ebuzz_api-specification_All modes.pdf under General Message API.

Example Request​

Headers​

{
"Authorization": "Bearer eyBDyGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDdXN0b21lcklkIjoiMTUyMyIsIm5Ob2RlTGljZW5zZUV4cGlyeSI6IjE4OTM2MDkwMDAiLCJpYXQiOjE1NjM2MDI2Nzd9.oRVgIlN3K_m5AXh_K1M88exzBg96CYJEVo_LQ-YZ6Yd"
}

Request Body​

{
"label": "GENERAL",
"message": "4|||SIDDIK,HO|1|test333|test1232223555|WEBADMIN|MODEM|||3"
}

Response​

The ResponseObject contains the following parameters in a JSON structure:

πŸ§ͺ Response Parameters​

Parameter (Key)Data TypeDescription
statusbooleanIndicates the status of the request. true if the response is successful, false if an error occurred.
errorCodestringError code if any error occurred.
errorStringstringError description.

Example Response​

{
"status": true,
"errorCode": "",
"errorString": "Notification sent successfully"
}